Operation Document.Hold (Apply Legal Hold)

In component org.nuxeo.retention.operations

Description

Turn the input document into a record and set a legal hold on it. Returns back the hold document.

Operation id	Document.Hold
Category	Retention
Label	Apply Legal Hold
Requires
Since

Parameters

Name	Description	Type	Required	Default value
description	Optional description of the hold	string	no

Signature

Inputs	document, documents
Outputs	document, documents

Implementation Information

Implementation Class	Class: org.nuxeo.retention.operations.HoldDocument
Contributing Component	org.nuxeo.retention.operations

JSON Definition

{
  "id" : "Document.Hold",
  "label" : "Apply Legal Hold",
  "category" : "Retention",
  "requires" : null,
  "description" : "Turn the input document into a record and set a legal hold on it. Returns back the hold document.",
  "url" : "Document.Hold",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "description",
    "description" : "Optional description of the hold",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}